Update api reference docs for links: part 1 - #12819
Conversation
🦋 Changeset detectedLatest commit: 6e272c1 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
commit: |
|
|
||
| For each query, the `http` field is used to modify each individual query in the batch, such as persisted queries (see below). | ||
|
|
||
| ### Persisted queries |
There was a problem hiding this comment.
I removed this section because 1) its not in HttpLink documentation 2) it feels random and 3) we should make sure PersistedQueryLink is used instead since it moves these levers. I don't think we want people manually settings these outside of PersistedQueryLink, at least for the purposes of persisted queries since there are a lot of details to get right outside of just sending extensions and not queries.
|
| All error types inherit the `name`, `message`, and nullable `stack` properties from the generic javascript [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error): | ||
| See the documentation on [Identifying error types](../../data/error-handling#identifying-error-types) to learn how to distinguish between the different error types. | ||
|
|
||
| ```js |
There was a problem hiding this comment.
I couldn't figure out what this was trying to say. I think it was supposed to be api reference documentation for these types? I linked these out in the table above so I just removed this.
| let string = renderDocComment(apiItem.tsdocComment); | ||
|
|
||
| string = string.replaceAll(/\{\{(\w+)\}\}/g, (_, variable) => { | ||
| string = string.replaceAll(/\\?\{\\?\{(\w+)\\?\}\\?\}/g, (_, variable) => { |
There was a problem hiding this comment.
This change fixes the warning in https://github.com/apollographql/apollo-client/actions/runs/16732740917/job/47364457350 by allowing us to escape the curlys when we see this warning. Now the following will also be replaced:
\{\{defaultValue\}\}
|
|
||
| #### Retrying failed connections | ||
|
|
||
| See the [`graphql-ws` recipes](https://the-guild.dev/graphql/ws/recipes) for strategies on retrying failed connections from the client. We recommend this approach as it provides more detailed information on the reason the connection failed. |
There was a problem hiding this comment.
| See the [`graphql-ws` recipes](https://the-guild.dev/graphql/ws/recipes) for strategies on retrying failed connections from the client. We recommend this approach as it provides more detailed information on the reason the connection failed. | |
| See the [`graphql-ws` recipes](https://the-guild.dev/graphql/ws/recipes) for strategies on retrying failed connections from the client. We generally recommend this approach over retrying connections from the link chain or your components, as it provides more detailed information on the reason the connection failed. |
|
|
||
| See the [`graphql-ws` recipes](https://the-guild.dev/graphql/ws/recipes) for strategies on retrying failed connections from the client. We recommend this approach as it provides more detailed information on the reason the connection failed. | ||
|
|
||
| You can also handle retries in the link chain in a more generic manner using the [`RetryLink`](./apollo-link-retry) to resend the operation to the terminating link. |
There was a problem hiding this comment.
| You can also handle retries in the link chain in a more generic manner using the [`RetryLink`](./apollo-link-retry) to resend the operation to the terminating link. | |
| Alternatively, you can handle retries in the link chain in a more generic manner using the [`RetryLink`](./apollo-link-retry) to resend the operation to the terminating link. |
90ba396 to
ed28279
Compare
201376e to
6e272c1
Compare
2 participants
No description provided.